﻿/*
	Copyright (c) 2013 Andrew Meyer

	Permission is hereby granted, free of charge, to any person obtaining a copy of this software
	and associated documentation files (the "Software"), to deal in the Software without
	restriction, including without limitation the right to use, copy, modify, merge, publish,
	distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
	Software is furnished to do so, subject to the following conditions:

	The above copyright notice and this permission notice shall be included in all copies or
	substantial portions of the Software.

	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
	BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
	NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
	DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/

using System.Collections.Generic;

namespace Ascend
{
	/// <summary>
	/// Containter for animation frame data. This class cannot be inherited.
	/// </summary>
	public sealed class AnimationFrame
	{
		#region Lifecycle
		/// <summary>
		/// Initializes a new instance of the Ascend.AnimationFrame class.
		/// </summary>
		public AnimationFrame()
		{
			BonePoses = new Dictionary<Bone, ObjectPose>();
		}
		#endregion

		#region Public Properties
		/// <summary>
		/// Gets or sets the model pose associated with this frame.
		/// </summary>
		public ObjectPose ModelPose
		{
			get;
			set;
		}

		/// <summary>
		/// Gets the bone poses associated with this frame.
		/// </summary>
		public Dictionary<Bone, ObjectPose> BonePoses
		{
			get;
			private set;
		}
		#endregion

		#region Public Methods
		/// <summary>
		/// Creates a deep copy of this Ascend.AnimationFrame.
		/// </summary>
		/// <returns>
		/// Returns the deep copy.
		/// </returns>
		public AnimationFrame Clone()
		{
			AnimationFrame clone = new AnimationFrame
			{
				ModelPose = (ModelPose != null)
					? ModelPose.Clone()
					: null
			};

			foreach (var kvp in BonePoses)
			{
				clone.BonePoses.Add(kvp.Key, kvp.Value.Clone());
			}

			return clone;
		}
		#endregion
	}
}
